[fix] Process symlinked routes by mikenikles · Pull Request #4957 · sveltejs/kit

mikenikles · 2022-05-16T19:35:46Z

Fixes #4936.

Process files within sym-linked directories.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
This message body should clearly illustrate what problems it solves.
Ideally, include a test that fails without this PR but passes with it.

Tests

Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

changeset-bot · 2022-05-16T19:35:49Z

🦋 Changeset detected

Latest commit: 3980e3c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@sveltejs/kit	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/kit/src/core/sync/create_manifest_data/index.js

mrkishi

As per @Conduitry's comment, this would error on symlinks to files, as readdirSync throws when not called on a directory.

There seems to be a problem with Node's fs.readdirSync(dir, { withFileTypes: true }) returning false for isDirectory() on symlinks (open issue at nodejs/node#30646). It doesn't seem likely to get fixed upstream in a timely manner, so reverting to fs.statSync instead of withFileTypes seems like a better solution.

mikenikles · 2022-05-18T04:06:57Z

Thank you folks, I reverted to the fs.statSync approach in 801bd67.

packages/kit/src/core/sync/create_manifest_data/index.js

mrkishi · 2022-05-18T20:34:35Z

Thank you for the follow-up!

What should we do about the test? On Windows, the system's developer mode would have to be enabled as well as Git's core.symlinks, otherwise Git won't recreate the symlinks and it'll fail.

We could add core.symlinks to .gitconfig but that'd still fail when developer mode is disabled. Perhaps it'd be okay to skip it on Windows?

Co-authored-by: Maurício Kishi <mrkishi@users.noreply.github.com>

mikenikles · 2022-05-18T21:45:26Z

Interesting, I see the tests on Windows passed with the latest commit, but failed previously - although I don't think it was because of the new test I added 🤔.

To make sure we have stable tests though, I agree that it's likely ok to skip on Windows. However, can you guide me into how I can exclude my sym-link test in a Windows environment?

mrkishi

Alright, I pushed changes so tests are skipped when symlinks don't make it through git.

lgtm.

Rich-Harris · 2022-05-23T15:00:40Z

thank you!

oneezy · 2022-06-02T04:31:05Z

Hey guys!
I went ahead and wrote a thorough breakdown of how our team got Sveltekit Symlink Routes working on Windows. This probably isn't the best place for it but wanted to share the process (would be cool to eventually see this explained in Kit Docs).

Thanks again @mikenikles for your help !

Windows Symlinks

Prerequisites

Symlink Permissions

You have 1 of 3 options. If you try to create a symlink without one of these, you will see:

Failed to create symbolic link 'link' : Operation not permitted

🟦 Option 1: Run as Administrator

When you make a symlink this way, you'll always need to open up the terminal as an Administrator.

🟦 Option 2: Developer Mode

This is the easiest way but not the safest (security risk).

Go to your start menu and search "Developer Settings".
Turn Developer Mode On.

✅ Option 3: Local Security Policy

Go to your start menu and search "Local Security Policy".
Double click on Create symbolic links

+ Security Settings > Local Policies > User Rights Assignment > Create symbolic links

Click the Add User or Group button
Type in your username and click the OK button
Click the Apply button
Restart your computer for the settings to take place

Choose a Path: `Command Prompt`, `Git Bash` or `WSL`

Command Prompt

Open the Command Prompt
Use cd to go into your project where you want to add the symlink

cd C:\Users\oneezy\Desktop\sveltekit-symlinks\src\routes

Create a relative symlink (not absolute!) to a directory folder (not a file!)

mklink /D my-new-symlink ..\..\symlinked-docs

And your finished!

Git Bash

Step 1. Setting System Environment Variables

🟦 Option 1: Exporting variable per session (tedious)

In your terminal you'll need to write the following command every time you restart git bash.

export MSYS=winsymlinks:nativestrict

✅ Option 2: Create an entry for MSYS (once)

Go to your start menu and search for "System Settings"
Click the Environment Variables... button
Go to System variables section and click the New button
Enter in the New System Variable name and value and click the OK button.

Variable name:    MSYS
Variable value:   winsymlinks:nativestrict

Click the OK button again to confirm.
Congratulations! Now you have the power to create symlinks whenever you want!

Step 2. Enable Symlinks in Gitconfig

You may also need to enable symlinks in your .gitconfig user profile.

git config --global core.symlinks true

This will add the symlinks = true to C:\Users\username\.gitconfig

[core]
  symlinks = true

You may also need to manually add symlinks = true to the gitconfig inside C:\Program Files\Git\etc\gitconfig if it's not there already

[core]
  symlinks = true

Step 3. Create Symlink (Git Bash)

Open up Git Bash
Use cd to go into your project where you want to add the symlink

cd c/users/oneezy/desktop/sveltekit-symlinks/src/routes

Create a relative symlink (not absolute!) to a directory folder (not a file!)

ln -s ../../symlinked-docs my-new-symlink

And your finished!

PROTIP: To see a list of your symlinks use the ls -l command

oneezy@oneezy MINGW64 ~/Desktop/sveltekit-symlinks/src/routes (main)
$ ls -l

rw-r--r-- 1 oneezy 197609 1354 Jun  1 13:00 index.svelte
+lrwxrwxrwx 1 oneezy 197609   20 Jun  1 20:45 my-new-symlink -> ../../symlinked-docs/

[fix] Process sym-linked routes

c29f731

vercel bot deployed to Preview – kit May 16, 2022 19:36 View deployment

vercel bot deployed to Preview – kit-svelte-dev May 16, 2022 19:36 View deployment

Conduitry reviewed May 16, 2022

View reviewed changes

packages/kit/src/core/sync/create_manifest_data/index.js Outdated Show resolved Hide resolved

mrkishi requested changes May 16, 2022

View reviewed changes

Revert to fs.statSync

801bd67

vercel bot deployed to Preview – kit May 18, 2022 04:06 View deployment

vercel bot deployed to Preview – kit-svelte-dev May 18, 2022 04:06 View deployment

mrkishi reviewed May 18, 2022

View reviewed changes

packages/kit/src/core/sync/create_manifest_data/index.js Outdated Show resolved Hide resolved

Update packages/kit/src/core/sync/create_manifest_data/index.js

f4b6979

Co-authored-by: Maurício Kishi <mrkishi@users.noreply.github.com>

vercel bot deployed to Preview – kit May 18, 2022 20:58 View deployment

vercel bot deployed to Preview – kit-svelte-dev May 18, 2022 20:59 View deployment

mrkishi added 2 commits May 22, 2022 07:55

reword sym-linked to symlinked

a3d336a

skip symlinks tests when unsupported

3980e3c

mrkishi changed the title ~~[fix] Process sym-linked routes~~ [fix] Process symlinked routes May 22, 2022

mrkishi approved these changes May 22, 2022

View reviewed changes

vercel bot deployed to Preview – kit May 22, 2022 21:17 View deployment

vercel bot deployed to Preview – kit-svelte-dev May 22, 2022 21:18 View deployment

Rich-Harris merged commit eb2ab91 into sveltejs:master May 23, 2022

github-actions bot mentioned this pull request May 23, 2022

Version Packages (next) #5034

Merged

This was referenced Aug 27, 2022

Implement new layouts system #6174

Merged

🐛 Symlink routes no longer work (1.0.0-next.432 — PR #6174) #6303

Closed

oneezy mentioned this pull request Sep 14, 2022

[fix] symlink routes #6796

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[fix] Process symlinked routes#4957

[fix] Process symlinked routes#4957
Rich-Harris merged 5 commits intosveltejs:masterfrom
mikenikles:process-symlinked-routes

mikenikles commented May 16, 2022 •

edited by benmccann

Loading

Uh oh!

changeset-bot bot commented May 16, 2022 •

edited

Loading

Uh oh!

Uh oh!

mrkishi left a comment

Uh oh!

mikenikles commented May 18, 2022

Uh oh!

Uh oh!

mrkishi commented May 18, 2022 •

edited

Loading

Uh oh!

mikenikles commented May 18, 2022

Uh oh!

mrkishi left a comment

Uh oh!

Rich-Harris commented May 23, 2022

Uh oh!

oneezy commented Jun 2, 2022 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

mikenikles commented May 16, 2022 • edited by benmccann Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Changesets

Uh oh!

changeset-bot bot commented May 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

mrkishi left a comment

Choose a reason for hiding this comment

Uh oh!

mikenikles commented May 18, 2022

Uh oh!

Uh oh!

mrkishi commented May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mikenikles commented May 18, 2022

Uh oh!

mrkishi left a comment

Choose a reason for hiding this comment

Uh oh!

Rich-Harris commented May 23, 2022

Uh oh!

oneezy commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Windows Symlinks

Prerequisites

Symlink Permissions

Choose a Path: Command Prompt, Git Bash or WSL

Command Prompt

Git Bash

Step 1. Setting System Environment Variables

Step 2. Enable Symlinks in Gitconfig

Step 3. Create Symlink (Git Bash)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mikenikles commented May 16, 2022 •

edited by benmccann

Loading

changeset-bot bot commented May 16, 2022 •

edited

Loading

mrkishi commented May 18, 2022 •

edited

Loading

oneezy commented Jun 2, 2022 •

edited

Loading

Choose a Path: `Command Prompt`, `Git Bash` or `WSL`